Skip to content

[Helm] Add ServiceMonitor to the helm chart#767

Merged
okdas merged 10 commits intomainfrom
chore/add-service-monitor-helm
May 22, 2023
Merged

[Helm] Add ServiceMonitor to the helm chart#767
okdas merged 10 commits intomainfrom
chore/add-service-monitor-helm

Conversation

@okdas
Copy link
Copy Markdown
Contributor

@okdas okdas commented May 18, 2023

Description

Adds ServiceMonitor to the helm chart, so our software can be monitored by different monitoring stacks that support this CRD, which is just about an industry standard now.

We are going to use it in our infrastructure as well.

Also, included changes to run e2e tests within one, main GitHub action workflow because the other option wasn't working on non-default branches.

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library

List of changes

  • Add a new 'ServiceMonitor' object to the helm chart, which will be disabled by default because not everyone has this CRD installed on their cluster.
  • Adjusted e2e test workflow so it kicks off on pull requests.

Testing

  • make develop_test; if any code changes were made
  • make test_e2e on k8s LocalNet; if any code changes were made
  • e2e-devnet-test passes tests on DevNet; if any code was changed
  • Docker Compose LocalNet; if any major functionality was changed or introduced
  • k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@okdas okdas added infra Core infrastructure - not protocol related e2e-devnet-test Runs E2E tests on devnet labels May 18, 2023
@okdas okdas self-assigned this May 18, 2023
@reviewpad reviewpad bot added the small Pull request is small label May 18, 2023
@okdas okdas changed the title Add ServiceMonitor to the helm chart [Helm] Add ServiceMonitor to the helm chart May 18, 2023
workflow_dispatch:
push:
branches: [main]
paths-ignore:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that we now depend on the most recent gitsha from the pull request (PR) to include a container image, we should not hinder the continuous integration (CI) process from generating an image in cases where only a documentation change is made.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you leave an inline comment. Maybe something like OPTIMIZE: We generate new images even on non src code changes, but this cost is okay for now

@reviewpad reviewpad bot added medium Pull request is medium and removed small Pull request is small labels May 20, 2023


# Run e2e tests on devnet IF the PR has a label "e2e-devnet-test"
e2e-tests:
Copy link
Copy Markdown
Contributor Author

@okdas okdas May 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed a clarification in the Github Actions documentation that old implementation would only work on the default branch, so having a separate workflow did not work. Going to have a larger main workflow instead.

@okdas okdas marked this pull request as ready for review May 20, 2023 02:40
@okdas
Copy link
Copy Markdown
Contributor Author

okdas commented May 20, 2023

In addition to the changes related to this PR, I had to adjust a GitHub Action as they didn't work as expected.
But now you can actually see the e2e test passed! :)

@okdas okdas requested a review from dylanlott May 20, 2023 02:42
Copy link
Copy Markdown
Collaborator

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor need but otherwise LGTM

workflow_dispatch:
push:
branches: [main]
paths-ignore:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you leave an inline comment. Maybe something like OPTIMIZE: We generate new images even on non src code changes, but this cost is okay for now

@@ -170,6 +170,8 @@ service:
annotations: {}
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was going to ask you some stuff, but learnt everything from ChatGPT.

Screenshot 2023-05-22 at 4 07 50 PM

okdas and others added 2 commits May 22, 2023 16:11
Co-authored-by: Daniel Olshansky <olshansky@pokt.network>
@okdas okdas merged commit cb0a0ab into main May 22, 2023
@okdas okdas deleted the chore/add-service-monitor-helm branch May 22, 2023 23:16
bryanchriswhite added a commit that referenced this pull request May 23, 2023
* pokt/main:
  [Helm] Add ServiceMonitor to the helm chart (#767)
  Update PULL_REQUEST_TEMPLATE.md (#772)
  [CI/Infra] E2E tests on Argo Workflows (#737)
Olshansk added a commit that referenced this pull request May 24, 2023
## Description

Adds `ServiceMonitor` to the helm chart, so our software can be
monitored by different monitoring stacks that support this CRD, which is
just about an industry standard now.

We are going to use it in our infrastructure as well.

Also, included changes to run e2e tests within one, `main` GitHub action
workflow because the other option wasn't working on non-default
branches.

## Type of change

Please mark the relevant option(s):

- [x] New feature, functionality or library

## List of changes

- Add a new 'ServiceMonitor' object to the helm chart, which will be
disabled by default because not everyone has this CRD installed on their
cluster.
- Adjusted e2e test workflow so it kicks off on pull requests.


## Testing

- [ ] `make develop_test`; if any code changes were made
- [ ] `make test_e2e` on [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any code changes were made
- [x] `e2e-devnet-test` passes tests on
[DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd);
if any code was changed
- [ ] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [x] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made


## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Daniel Olshansky <olshansky@pokt.network>
bryanchriswhite added a commit that referenced this pull request May 26, 2023
* refactor/message-handling:
  Update client to p1 in makefile
  change gitsha of private-keys.yaml (#787)
  Fix places where we request a password and don't check the nonInterac… (#788)
  [Testing] [Tooling] chore: replace `gocuke` & `go-mockdns` in go.mod (#782)
  [k8s] Rename `client` to `p1` in k8s localnet (#764)
  [Persistence] Refactors BlockStore Interface (#774)
  [BUG] Int casting issue when sending tx (#783)
  fix: add  missing space to makefile
  add public keys to private-keys.yaml (#779)
  chore: update changelog
  chore: comment improvements
  fix: logger levels
  chore: improve func & var names'
  [Helm] Add ServiceMonitor to the helm chart (#767)
  Update PULL_REQUEST_TEMPLATE.md (#772)
  [CI/Infra] E2E tests on Argo Workflows (#737)
Olshansk added a commit that referenced this pull request Jun 1, 2023
## Description

Adds `ServiceMonitor` to the helm chart, so our software can be
monitored by different monitoring stacks that support this CRD, which is
just about an industry standard now.

We are going to use it in our infrastructure as well.

Also, included changes to run e2e tests within one, `main` GitHub action
workflow because the other option wasn't working on non-default
branches.

## Type of change

Please mark the relevant option(s):

- [x] New feature, functionality or library

## List of changes

- Add a new 'ServiceMonitor' object to the helm chart, which will be
disabled by default because not everyone has this CRD installed on their
cluster.
- Adjusted e2e test workflow so it kicks off on pull requests.


## Testing

- [ ] `make develop_test`; if any code changes were made
- [ ] `make test_e2e` on [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any code changes were made
- [x] `e2e-devnet-test` passes tests on
[DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd);
if any code was changed
- [ ] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [x] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made


## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Daniel Olshansky <olshansky@pokt.network>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

e2e-devnet-test Runs E2E tests on devnet infra Core infrastructure - not protocol related medium Pull request is medium waiting-for-review

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants